FoxitPDFSDKPython2.Range类 参考
类 FoxitPDFSDKPython2.Range 继承关系图:
Public 成员函数 | |
| def | Range () |
| 构造函数。 | |
| def | Range (index) |
| 带有单个索引的构造函数。 更多... | |
| def | Range (start_index, end_index, filter) |
| 带有指定索引范围的构造函数。 更多... | |
| def | Range (other) |
| 使用另一个范围对象的构造函数。 更多... | |
| def | AddSegment (start_index, end_index, filter) |
| 添加新的范围段。（反向排序是合法的。） 更多... | |
| def | AddSingle (index) |
| 添加索引作为新的范围段。 更多... | |
| def | GetSegmentCount () |
| 获取范围段的数量。 更多... | |
| def | GetSegmentEnd (segment_index) |
| 获取指定范围段的结束索引。 更多... | |
| def | GetSegmentStart (segment_index) |
| 获取指定范围段的起始索引。 更多... | |
| def | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| def | RemoveAll () |
| 移除所有范围段。 更多... | |
静态 Public 属性 | |
| e_All = _fsdk.Range_e_All | |
| 范围内的所有索引都将被使用。 | |
| e_Even = _fsdk.Range_e_Even | |
| 只使用范围内的偶数（丢弃奇数）。 | |
| e_Odd = _fsdk.Range_e_Odd | |
| 只使用范围内的奇数（丢弃偶数）。 | |
详细描述
此类表示索引范围。在这里，范围由一个或多个段组成，每个段由 单个索引或一组连续索引组成。
对于某些特殊情况，例如在 pdf::HeaderFooter 中使用的，此范围中指定的索引值直接表示页码而不是页面索引。
构造及析构函数说明
◆ Range() [1/3]
| def FoxitPDFSDKPython2.Range.Range | ( | index | ) |
带有单个索引的构造函数。
- 参数
-
[in] index 单个索引。
◆ Range() [2/3]
| def FoxitPDFSDKPython2.Range.Range | ( | start_index, | |
| end_index, | |||
| filter | |||
| ) |
带有指定索引范围的构造函数。
- 参数
-
[in] start_index 范围段的起始索引。 [in] end_index 范围段的结束索引。 [in] filter 过滤器类型，用于决定此范围的哪些索引将被使用。请参考从 FoxitPDFSDKPython2.Range.e_All 开始的值，应该是这些值中的一个。 默认值：FoxitPDFSDKPython2.Range.e_All 。
特别地，当此值为 FoxitPDFSDKPython2.Range.e_Even 或 FoxitPDFSDKPython2.Range.e_Odd 时， 意味着指定范围段内的每个偶数或奇数将 被视为单个段。
◆ Range() [3/3]
| def FoxitPDFSDKPython2.Range.Range | ( | other | ) |
使用另一个范围对象的构造函数。
- 参数
-
[in] other 另一个范围对象。
成员函数说明
◆ AddSegment()
| def FoxitPDFSDKPython2.Range.AddSegment | ( | start_index, | |
| end_index, | |||
| filter | |||
| ) |
添加新的范围段。（反向排序是合法的。）
- 参数
-
[in] start_index 新范围段的起始索引。 [in] end_index 新范围段的结束索引。 [in] filter 过滤器类型，用于决定此范围的哪些索引将被使用。请参考从 FoxitPDFSDKPython2.Range.e_All 开始的值，应该是这些值中的一个。 默认值：FoxitPDFSDKPython2.Range.e_All 。
特别地，当此值为 FoxitPDFSDKPython2.Range.e_Even 或 FoxitPDFSDKPython2.Range.e_Odd 时， 意味着指定范围段内的每个偶数或奇数将 被视为单个段。
- 返回
- 无。
◆ AddSingle()
| def FoxitPDFSDKPython2.Range.AddSingle | ( | index | ) |
添加索引作为新的范围段。
- 参数
-
[in] index 要作为新范围段添加的索引。
◆ GetSegmentCount()
| def FoxitPDFSDKPython2.Range.GetSegmentCount | ( | ) |
获取范围段的数量。
- 返回
- 范围段的数量。
◆ GetSegmentEnd()
| def FoxitPDFSDKPython2.Range.GetSegmentEnd | ( | segment_index | ) |
获取指定范围段的结束索引。
- 参数
-
[in] segment_index 段索引。有效范围：0到(count-1)。 count由函数 FoxitPDFSDKPython2.Range.GetSegmentCount 返回。
- 返回
- 指定范围段的结束索引。
◆ GetSegmentStart()
| def FoxitPDFSDKPython2.Range.GetSegmentStart | ( | segment_index | ) |
获取指定范围段的起始索引。
- 参数
-
[in] segment_index 段索引。有效范围：0到(count-1)。 count由函数 FoxitPDFSDKPython2.Range.GetSegmentCount 返回。
- 返回
- 指定范围段的起始索引。
◆ IsEmpty()
| def FoxitPDFSDKPython2.Range.IsEmpty | ( | ) |
检查当前对象是否为空。
当当前对象为空时，意味着当前对象无用。
- 返回
- true 表示当前对象为空，false 表示不为空。
◆ RemoveAll()
| def FoxitPDFSDKPython2.Range.RemoveAll | ( | ) |
移除所有范围段。
- 返回
- 无。
